Skip to content

Remove comments that restate the code - #27

Merged
laurenspriem merged 1 commit into
ente:mainfrom
laurens-pilot:chore/remove-deducible-comments
Nov 3, 2026
Merged

laurenspriem merged 1 commit into
ente:mainfrom
laurens-pilot:chore/remove-deducible-comments

Conversation

@laurens-pilot

Copy link
Copy Markdown

Removes every comment the code already expresses across the decoder, the test scripts and the CI workflow, including rustdoc on public items. What stays is only what the code can't say: SAFETY arguments, overflow and saturation reasoning, deliberate libheif/libde265 parity choices and known divergences, and why unsupported stream features are rejected outright.

Behavior is unchanged. The only code edit is collapsing else { if … } to else if in decode_part_mode, which clippy requires once the comment between them is gone.

Public items no longer carry rustdoc. API.md still documents most of the API, but the RGB8 entry points (DecodedRgbImage, decode_bytes_to_rgb8, decode_path_to_rgb8) are now undocumented outside the code.

Source fork PR: laurens-pilot#15

@laurenspriem

Keep only comments carrying information the code cannot express: unsafe
soundness arguments, overflow and saturation reasoning, deliberate libheif
and libde265 parity choices and divergences, and the reasons behind
loud rejections of unsupported stream features.
@laurenspriem
laurenspriem merged commit 0524693 into ente:main Nov 3, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants